|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.team.ui.synchronize.AbstractSynchronizeParticipant
AbstractSynchronizeParticipant is the abstract base class for all synchronize view participants. It provides default lifecycle support for participants.
ISynchronizeParticipant
Field Summary | |
protected IConfigurationElement |
configElement
|
Constructor Summary | |
AbstractSynchronizeParticipant()
|
Method Summary | |
void |
addPropertyChangeListener(IPropertyChangeListener listener)
Adds a listener for changes to properties of this synchronize participant. |
void |
firePropertyChange(Object source,
String property,
Object oldValue,
Object newValue)
Notify all listeners that the given property has changed. |
String |
getId()
Returns the unique id that identified the type of this synchronize participant. |
ImageDescriptor |
getImageDescriptor()
Returns an image descriptor for this synchronize participant, or null
if none. |
String |
getName()
Returns the name of this synchronize participant. |
void |
init(IMemento memento)
Initializes this participant with the given participant state. |
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the given property listener from this synchronize participant. |
void |
saveState(IMemento memento)
Saves the participants object state within the memento. |
protected void |
setImageDescriptor(ImageDescriptor imageDescriptor)
Sets the image descriptor for this console to the specified value and notifies property listeners of the change. |
void |
setInitializationData(IConfigurationElement config,
String propertyName,
Object data)
This method is called by the implementation of the method IConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration
information. |
protected void |
setInitializationData(ISynchronizeParticipantDescriptor descriptor)
|
protected void |
setName(String name)
Sets the name of this console to the specified value and notifies property listeners of the change. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.team.ui.synchronize.ISynchronizeParticipant |
createPage, dispose |
Field Detail |
protected IConfigurationElement configElement
Constructor Detail |
public AbstractSynchronizeParticipant()
Method Detail |
public String getName()
ISynchronizeParticipant
getName
in interface ISynchronizeParticipant
public ImageDescriptor getImageDescriptor()
ISynchronizeParticipant
null
if none.
getImageDescriptor
in interface ISynchronizeParticipant
null
if nonepublic String getId()
ISynchronizeParticipant
getId
in interface ISynchronizeParticipant
public void addPropertyChangeListener(IPropertyChangeListener listener)
ISynchronizeParticipant
The changes supported by the synchronize view are as follows:
IBasicPropertyConstants.P_TEXT
- indicates the name
of a synchronize participant has changedIBasicPropertyConstants.P_IMAGE
- indicates the
image of a synchronize participant has changedClients may define additional properties as required.
addPropertyChangeListener
in interface ISynchronizeParticipant
listener
- a property change listenerpublic void removePropertyChangeListener(IPropertyChangeListener listener)
ISynchronizeParticipant
removePropertyChangeListener
in interface ISynchronizeParticipant
listener
- a property listenerpublic void firePropertyChange(Object source, String property, Object oldValue, Object newValue)
source
- the object on which a property has changedproperty
- identifier of the property that has changedoldValue
- the old value of the property, or null
newValue
- the new value of the property, or null
public void setInitializationData(IConfigurationElement config, String propertyName, Object data) throws CoreException
IExecutableExtension
IConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration
information. Most executable extensions only make use of the first
two call arguments.
Regular executable extensions specify their Java implementation class name as an attribute of the configuration element for the extension. For example
<action run="com.example.BaseAction"/>In the above example, this method would be called with a reference to the
<action>
element (first argument), and
"run"
as the name of the attribute that defined
this executable extension (second argument).
The last parameter is for the specific use of extension adapters and is typically not used by regular executable extensions.
There are two supported ways of associating additional adapter-specific data with the configuration in a way that is transparent to the extension point implementor:
(1) by specifying adapter data as part of the implementation
class attribute value. The Java class name can be followed
by a ":" separator, followed by any adapter data in string
form. For example, if the extension point specifies an attribute
"run"
to contain the name of the extension implementation,
an adapter can be configured as
<action run="com.example.ExternalAdapter:./cmds/util.exe -opt 3"/>
(2) by converting the attribute used to specify the executable extension to a child element of the original configuration element, and specifying the adapter data in the form of xml markup. Using this form, the example above would become
<action> <run class="com.xyz.ExternalAdapter"> <parameter name="exec" value="./cmds/util.exe"/> <parameter name="opt" value="3"/> </run > </action>
Form (2) will typically only be used for extension points that anticipate the majority of extensions configured into it will in fact be in the form of adapters.
In either case, the specified adapter class is instantiated using its 0-argument public constructor. The adapter data is passed as the last argument of this method. The data argument is defined as Object. It can have the following values:
null
, if no adapter data was suppliedString
Hashtable
containing the actual
parameter names and values (both String
s)
setInitializationData
in interface IExecutableExtension
config
- the configuration element used to trigger this execution.
It can be queried by the executable extension for specific
configuration propertiespropertyName
- the name of an attribute of the configuration element
used on the createExecutableExtension(String)
call. This
argument can be used in the cases where a single configuration element
is used to define multiple executable extensions.data
- adapter data in the form of a String
,
a Hashtable
, or null
.
CoreException
- if error(s) detected during initialization processingIConfigurationElement.createExecutableExtension(java.lang.String)
protected void setInitializationData(ISynchronizeParticipantDescriptor descriptor) throws CoreException
CoreException
protected void setName(String name)
name
- the new nameprotected void setImageDescriptor(ImageDescriptor imageDescriptor)
imageDescriptor
- the new image descriptorpublic void init(IMemento memento) throws PartInitException
ISynchronizeParticipant
This method is automatically called by the team plugin shortly after participant construction. It marks the start of the views's lifecycle. Clients must not call this method.
init
in interface ISynchronizeParticipant
memento
- the participant state or null
if there
is no previous saved state
PartInitException
- if this participant was not initialized
successfullypublic void saveState(IMemento memento)
ISynchronizeParticipant
init
.
saveState
in interface ISynchronizeParticipant
memento
- a memento to receive the object state
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |